Micron Document
welo git mirrors

Node / public / rns-proxy / commits / 9c2d9ba

Commit 9c2d9ba7a4efec5cd3d145017a6c02c5ed8ddc5b

🗀 Browse tree at this commit

Parents : a86d04c
Author : Welo <welolololgamer@gmail.com>
Signature : Signature validation error
Date : 2026-07-15T23:11:21+01:00
Committer : GitHub <noreply@github.com>
Date : 2026-07-15T23:11:21+01:00

Update README.md to add the new commands

Changes

1 files changed, 28 insertions(+), 22 deletions(-)

M README.md +28 -22

Diff

diff --git a/README.md b/README.md
index e353097..9d91e5a 100644
--- a/README.md
+++ b/README.md
@@ -106,6 +106,16 @@ Server started. Client address:
<32-hex-char-destination-hash>
```
+#### Connect
+
+To start a exit node that can only connect to certain localhost ports, you can instead do
+
+```bash
+rns-proxy forward -t 80 -u 23 -b 65000
+```
+
+which will forward tcp port 80, udp port 23 and forward both the tcp and udp ports of 65000. Any amount of ports can be specified.
+
### Start the client
On the local machine:
@@ -126,7 +136,7 @@ To make the proxy accessible from other devices on the network:
rns-proxy client -d <hash-from-server> -l 0.0.0.0:1080
```
-### Use it
+#### Use it
Configure any application to use `127.0.0.1:1080` as a SOCKS5 proxy:
@@ -134,6 +144,21 @@ Configure any application to use `127.0.0.1:1080` as a SOCKS5 proxy:
curl --socks5 127.0.0.1:1080 https://example.com
```
+#### Connect
+
+Connect to the localhost ports of the server and port forward it to your own localhost port.
+
+```bash
+rns-proxy connect -d <hash-from-server> -t 7657
+```
+
+You can also choose what client port instead of defaulting to the server's with a colon followed by the port number that should be opened
+
+```bash
+rns-proxy connect -d <hash-from-server> -t 7657:5601
+```
+
+
## CLI
```
@@ -142,6 +167,8 @@ rns-proxy [OPTIONS] <COMMAND>
Commands:
server Run the proxy server (exit node)
client Run the proxy client (local SOCKS5)
+ connect Connects to the localhost ports of the server (Port forwarding)
+ forward Exposes a SOCKS5 proxy that only allows clients to connect to the specified localhost ports.
Options:
--debug Enable debug logging
@@ -149,27 +176,6 @@ Options:
-h, --help Print help
```
-**Server options:**
-
-```
-rns-proxy server [--identity-file <PATH>]
-```
-
-| Option | Default | Description |
-|---|---|---|
-| `--identity-file` | `~/.reticulum/rns_proxy_identity` | Path to the persistent identity file |
-
-**Client options:**
-
-```
-rns-proxy client -d <HASH> [-l 127.0.0.1:1080]
-```
-
-| Option | Default | Description |
-|---|---|---|
-| `-d`, `--destination` | required | RNS destination hash (hex) |
-| `-l`, `--listen` | `127.0.0.1:1080` | Local SOCKS5 listen address |
-
## Protocol
Multiplexed frame format (wire-compatible with the [Python implementation](https://github.com/rsgrinko/reticulum-socks5-proxy)):

Served by rngit 1.4.2 - Generated in 0.06s